home *** CD-ROM | disk | FTP | other *** search
/ IRIX Base Documentation 2002 November / SGI IRIX Base Documentation 2002 November.iso / usr / share / catman / p_man / cat3 / SCSL / ctbrfs.z / ctbrfs
Encoding:
Text File  |  2002-10-03  |  5.9 KB  |  199 lines

  1.  
  2.  
  3.  
  4. CCCCTTTTBBBBRRRRFFFFSSSS((((3333SSSS))))                                                          CCCCTTTTBBBBRRRRFFFFSSSS((((3333SSSS))))
  5.  
  6.  
  7.  
  8. NNNNAAAAMMMMEEEE
  9.      CTBRFS - provide error bounds and backward error estimates for the
  10.      solution to a system of linear equations with a triangular band
  11.      coefficient matrix
  12.  
  13. SSSSYYYYNNNNOOOOPPPPSSSSIIIISSSS
  14.      SUBROUTINE CTBRFS( UPLO, TRANS, DIAG, N, KD, NRHS, AB, LDAB, B, LDB, X,
  15.                         LDX, FERR, BERR, WORK, RWORK, INFO )
  16.  
  17.          CHARACTER      DIAG, TRANS, UPLO
  18.  
  19.          INTEGER        INFO, KD, LDAB, LDB, LDX, N, NRHS
  20.  
  21.          REAL           BERR( * ), FERR( * ), RWORK( * )
  22.  
  23.          COMPLEX        AB( LDAB, * ), B( LDB, * ), WORK( * ), X( LDX, * )
  24.  
  25. IIIIMMMMPPPPLLLLEEEEMMMMEEEENNNNTTTTAAAATTTTIIIIOOOONNNN
  26.      These routines are part of the SCSL Scientific Library and can be loaded
  27.      using either the -lscs or the -lscs_mp option.  The -lscs_mp option
  28.      directs the linker to use the multi-processor version of the library.
  29.  
  30.      When linking to SCSL with -lscs or -lscs_mp, the default integer size is
  31.      4 bytes (32 bits). Another version of SCSL is available in which integers
  32.      are 8 bytes (64 bits).  This version allows the user access to larger
  33.      memory sizes and helps when porting legacy Cray codes.  It can be loaded
  34.      by using the -lscs_i8 option or the -lscs_i8_mp option. A program may use
  35.      only one of the two versions; 4-byte integer and 8-byte integer library
  36.      calls cannot be mixed.
  37.  
  38. PPPPUUUURRRRPPPPOOOOSSSSEEEE
  39.      CTBRFS provides error bounds and backward error estimates for the
  40.      solution to a system of linear equations with a triangular band
  41.      coefficient matrix. The solution matrix X must be computed by CTBTRS or
  42.      some other means before entering this routine.  CTBRFS does not do
  43.      iterative refinement because doing so cannot improve the backward error.
  44.  
  45.  
  46. AAAARRRRGGGGUUUUMMMMEEEENNNNTTTTSSSS
  47.      UPLO    (input) CHARACTER*1
  48.              = 'U':  A is upper triangular;
  49.              = 'L':  A is lower triangular.
  50.  
  51.      TRANS   (input) CHARACTER*1
  52.              Specifies the form of the system of equations:
  53.              = 'N':  A * X = B     (No transpose)
  54.              = 'T':  A**T * X = B  (Transpose)
  55.              = 'C':  A**H * X = B  (Conjugate transpose)
  56.  
  57.      DIAG    (input) CHARACTER*1
  58.              = 'N':  A is non-unit triangular;
  59.              = 'U':  A is unit triangular.
  60.  
  61.  
  62.  
  63.                                                                         PPPPaaaaggggeeee 1111
  64.  
  65.  
  66.  
  67.  
  68.  
  69.  
  70. CCCCTTTTBBBBRRRRFFFFSSSS((((3333SSSS))))                                                          CCCCTTTTBBBBRRRRFFFFSSSS((((3333SSSS))))
  71.  
  72.  
  73.  
  74.      N       (input) INTEGER
  75.              The order of the matrix A.  N >= 0.
  76.  
  77.      KD      (input) INTEGER
  78.              The number of superdiagonals or subdiagonals of the triangular
  79.              band matrix A.  KD >= 0.
  80.  
  81.      NRHS    (input) INTEGER
  82.              The number of right hand sides, i.e., the number of columns of
  83.              the matrices B and X.  NRHS >= 0.
  84.  
  85.      AB      (input) COMPLEX array, dimension (LDAB,N)
  86.              The upper or lower triangular band matrix A, stored in the first
  87.              kd+1 rows of the array. The j-th column of A is stored in the j-
  88.              th column of the array AB as follows:  if UPLO = 'U', AB(kd+1+i-
  89.              j,j) = A(i,j) for max(1,j-kd)<=i<=j; if UPLO = 'L', AB(1+i-j,j)
  90.              = A(i,j) for j<=i<=min(n,j+kd).  If DIAG = 'U', the diagonal
  91.              elements of A are not referenced and are assumed to be 1.
  92.  
  93.      LDAB    (input) INTEGER
  94.              The leading dimension of the array AB.  LDAB >= KD+1.
  95.  
  96.      B       (input) COMPLEX array, dimension (LDB,NRHS)
  97.              The right hand side matrix B.
  98.  
  99.      LDB     (input) INTEGER
  100.              The leading dimension of the array B.  LDB >= max(1,N).
  101.  
  102.      X       (input) COMPLEX array, dimension (LDX,NRHS)
  103.              The solution matrix X.
  104.  
  105.      LDX     (input) INTEGER
  106.              The leading dimension of the array X.  LDX >= max(1,N).
  107.  
  108.      FERR    (output) REAL array, dimension (NRHS)
  109.              The estimated forward error bound for each solution vector X(j)
  110.              (the j-th column of the solution matrix X).  If XTRUE is the true
  111.              solution corresponding to X(j), FERR(j) is an estimated upper
  112.              bound for the magnitude of the largest element in (X(j) - XTRUE)
  113.              divided by the magnitude of the largest element in X(j).  The
  114.              estimate is as reliable as the estimate for RCOND, and is almost
  115.              always a slight overestimate of the true error.
  116.  
  117.      BERR    (output) REAL array, dimension (NRHS)
  118.              The componentwise relative backward error of each solution vector
  119.              X(j) (i.e., the smallest relative change in any element of A or B
  120.              that makes X(j) an exact solution).
  121.  
  122.      WORK    (workspace) COMPLEX array, dimension (2*N)
  123.  
  124.  
  125.  
  126.  
  127.  
  128.  
  129.                                                                         PPPPaaaaggggeeee 2222
  130.  
  131.  
  132.  
  133.  
  134.  
  135.  
  136. CCCCTTTTBBBBRRRRFFFFSSSS((((3333SSSS))))                                                          CCCCTTTTBBBBRRRRFFFFSSSS((((3333SSSS))))
  137.  
  138.  
  139.  
  140.      RWORK   (workspace) REAL array, dimension (N)
  141.  
  142.      INFO    (output) INTEGER
  143.              = 0:  successful exit
  144.              < 0:  if INFO = -i, the i-th argument had an illegal value
  145.  
  146. SSSSEEEEEEEE AAAALLLLSSSSOOOO
  147.      INTRO_LAPACK(3S), INTRO_SCSL(3S)
  148.  
  149.      This man page is available only online.
  150.  
  151.  
  152.  
  153.  
  154.  
  155.  
  156.  
  157.  
  158.  
  159.  
  160.  
  161.  
  162.  
  163.  
  164.  
  165.  
  166.  
  167.  
  168.  
  169.  
  170.  
  171.  
  172.  
  173.  
  174.  
  175.  
  176.  
  177.  
  178.  
  179.  
  180.  
  181.  
  182.  
  183.  
  184.  
  185.  
  186.  
  187.  
  188.  
  189.  
  190.  
  191.  
  192.  
  193.  
  194.  
  195.                                                                         PPPPaaaaggggeeee 3333
  196.  
  197.  
  198.  
  199.